Skip to main content

Webhook: TASK_CANCELLED

Обзор​

Webhook TASK_CANCELLED срабатывает, когда задача отменяется сотрудником. Это позволяет уведомлять заинтересованные системы или пользователей, обеспечивая обновление статусов задач, планирование ресурсов и отслеживание активности.

Цель​

Webhook помогает интегрировать уведомления о отменах задач в внешние системы в реальном времени, позволяя заинтересованным сторонам предпринять необходимые действия (например, перераспределить ресурсы или обновить рабочие процессы).

Формат запроса​

Webhook отправляется в виде HTTP POST запроса с следующим пейлоадом:

{
   "entityId": "9af5d7b0-b1e2-4436-b02e-1c6346eb09d1",
   "type": "TASK_CANCELLED",
   "createdAt": "2024-12-16T11:53:01.158Z",
   "data": {
      "id": "9af5d7b0-b1e2-4436-b02e-1c6346eb09d1",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T12:00:00.000Z",
      "endAt": "2024-12-16T13:00:00.000Z",
      "name": "Task 3",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": null,
      "actionId": null
   },
   "id": 201
}

Ключевые свойства​

Верхний уровень​

  • entityId: Уникальный идентификатор отмененной задачи.
  • type: Указывает тип webhook (TASK_CANCELLED).
  • createdAt: Временная метка срабатывания webhook в формате ISO 8601.
  • data: Содержит подробную информацию о задаче.

Раздел данных​

  • id: Идентификатор отмененной задачи.
  • organizationId: Идентификатор организации, связанной с задачей.
  • locationId: Идентификатор местоположения, связанного с задачей.
  • startAt: Время начала задачи (в формате ISO 8601).
  • endAt: Время завершения задачи (в формате ISO 8601).
  • name: Название или заголовок задачи.
  • assigneeIds: Список идентификаторов пользователей, назначенных на задачу.
  • recurrenceRule: Правила повторения задачи (если есть, в данном случае null).
  • stepId: Идентификатор конкретного шага в рабочем процессе (null, если не применимо).
  • actionId: Идентификатор связанного действия (null, если не применимо).

Пример ответа​

Пример пейлоада для webhook, представляющего успешно отмененную задачу:

{
   "entityId": "9af5d7b0-b1e2-4436-b02e-1c6346eb09d1",
   "type": "TASK_CANCELLED",
   "createdAt": "2024-12-16T11:53:01.158Z",
   "data": {
      "id": "9af5d7b0-b1e2-4436-b02e-1c6346eb09d1",
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
      "startAt": "2024-12-16T12:00:00.000Z",
      "endAt": "2024-12-16T13:00:00.000Z",
      "name": "Task 3",
      "assigneeIds": [
         "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      ],
      "recurrenceRule": null,
      "stepId": null,
      "actionId": null
   }
}

Преимущества webhook TASK_CANCELLED​

  1. Обновления в реальном времени: Обеспечивает немедленное уведомление внешних систем или заинтересованных сторон об отменах задач.
  2. Улучшенное планирование: Помогает обновить расписания и перераспределить ресурсы на основе отмененных задач.
  3. Оптимизация рабочих процессов: Позволяет внешним системам эффективно адаптировать рабочие процессы или зависимости.

Webhook TASK_CANCELLED предоставляет важную информацию для поддержания консистентности и точности в системах управления задачами.